Summary

Fully Qualified Name:	Laminas\Barcode\Renderer\Pdf
Extends:	AbstractRenderer

Description

Methods

Name	Description	Defined By
__construct()	Constructor	AbstractRenderer
checkParams()	Checking of parameters after all settings	AbstractRenderer
draw()	Draw the barcode in the rendering resource	AbstractRenderer
getAutomaticRenderError()	Retrieve the automatic rendering of exception	AbstractRenderer
getBarcode()	Retrieve the barcode object	AbstractRenderer
getHorizontalPosition()	Horizontal position of the barcode in the rendering resource	AbstractRenderer
getLeftOffset()	Retrieve vertical adjustment	AbstractRenderer
getModuleSize()	Set the size of a module	AbstractRenderer
getRendererNamespace()	Retrieve renderer namespace	AbstractRenderer
getTopOffset()	Retrieve vertical adjustment	AbstractRenderer
getTransparentBackground()		AbstractRenderer
getType()	Retrieve renderer type	AbstractRenderer
getVerticalPosition()	Vertical position of the barcode in the rendering resource	AbstractRenderer
render()	Draw the barcode in the PDF, send headers and the PDF	Pdf
setAutomaticRenderError()	Activate/Deactivate the automatic rendering of exception	AbstractRenderer
setBarcode()	Set the barcode object	AbstractRenderer
setHorizontalPosition()	Horizontal position of the barcode in the rendering resource	AbstractRenderer
setLeftOffset()	Manually adjust left position	AbstractRenderer
setModuleSize()	Set the size of a module	AbstractRenderer
setOptions()	Set renderer state from options array	AbstractRenderer
setRendererNamespace()	Set renderer namespace for autoloading	AbstractRenderer
setResource()	Set a PDF resource to draw the barcode inside	Pdf
setTopOffset()	Manually adjust top position	AbstractRenderer
setTransparentBackground()	Set whether background should be transparent Will work for SVG and Image (png and gif only)	AbstractRenderer
setVerticalPosition()	Vertical position of the barcode in the rendering resource	AbstractRenderer
widthForStringUsingFontSize()	Calculate the width of a string: in case of using alignment parameter in drawText	Pdf

Method Details

__construct()

Constructor

Parameter Name	Type	Description
$options	array|\Traversable

Returns:

checkParams()

Checking of parameters after all settings

Returns: bool

draw()

Draw the barcode in the rendering resource

Returns: mixed

getAutomaticRenderError()

Retrieve the automatic rendering of exception

Returns: bool

getBarcode()

Retrieve the barcode object

Returns: \Object\ObjectInterface

getHorizontalPosition()

Horizontal position of the barcode in the rendering resource

Returns: string

getLeftOffset()

Retrieve vertical adjustment

Returns: int

getModuleSize()

Set the size of a module

Returns: float

getRendererNamespace()

Retrieve renderer namespace

Returns: string

getTopOffset()

Retrieve vertical adjustment

Returns: int

getTransparentBackground()

Returns: bool

getType()

Retrieve renderer type

Returns: string

getVerticalPosition()

Vertical position of the barcode in the rendering resource

Returns: string

render()

Draw the barcode in the PDF, send headers and the PDF

Returns: mixed

setAutomaticRenderError()

Activate/Deactivate the automatic rendering of exception

Parameter Name	Type	Description
$value	bool

Returns: self Provides a fluent interface

setBarcode()

Set the barcode object

Parameter Name	Type	Description
$barcode	\Object\ObjectInterface

Returns: self Provides a fluent interface

setHorizontalPosition()

Horizontal position of the barcode in the rendering resource

Parameter Name	Type	Description
$value	string

Returns: self Provides a fluent interface

setLeftOffset()

Manually adjust left position

Parameter Name	Type	Description
$value	int

Returns: self Provides a fluent interface

setModuleSize()

Set the size of a module

Parameter Name	Type	Description
$value	float

Returns: self Provides a fluent interface

setOptions()

Set renderer state from options array

Parameter Name	Type	Description
$options	array

Returns: self Provides a fluent interface

setRendererNamespace()

Set renderer namespace for autoloading

Parameter Name	Type	Description
$namespace	string

Returns: self Provides a fluent interface

setResource()

Set a PDF resource to draw the barcode inside

Parameter Name	Type	Description
$pdf	\PdfDocument
$page	int

Returns: self Provides a fluent interface

setTopOffset()

Manually adjust top position

Parameter Name	Type	Description
$value	int

Returns: self Provides a fluent interface

setTransparentBackground()

Set whether background should be transparent Will work for SVG and Image (png and gif only)

Parameter Name	Type	Description
	$bool
$bool

Returns: self Provides a fluent interface

setVerticalPosition()

Vertical position of the barcode in the rendering resource

Parameter Name	Type	Description
$value	string

Returns: self Provides a fluent interface

widthForStringUsingFontSize()

Calculate the width of a string: in case of using alignment parameter in drawText

Parameter Name	Type	Description
$text	string
$font	\Font
$fontSize	float

Returns: float